﻿#region File and License Information
/*
<File>
	<License>
		Copyright © 2009 - 2017, Daniel Vaughan. All rights reserved.
		This file is part of Calcium (http://calciumsdk.net), 
		which is released under the MIT License.
		See file /Documentation/License.txt for details.
	</License>
	<CreationDate>2009-04-10 18:51:44Z</CreationDate>
</File>
*/
#endregion

namespace Outcoder.ComponentModel
{
	/// <summary>
	/// Allows an instance that implements this interface
	/// to provide information suitable for displaying directly 
	/// to a lay user.
	/// </summary>
	public interface IUserMessageProvider
	{
		/// <summary>
		/// Gets or sets the localized user message, that is appropriate 
		/// for displaying to a user.
		/// </summary>
		/// <value>The user message.</value>
		string UserMessage
		{
			get;
		}

		/// <summary>
		/// Gets a value indicating whether the UserMessage is <code>null</code>.
		/// </summary>
		/// <value><c>true</c> if the UserMessage is not <code>null</code>; 
		/// otherwise, <c>false</c>.</value>
		bool UserMessagePresent
		{
			get;
		}
	}
}
